/*******************************************************************************
 * Copyright 2014 United States Government as represented by the
 * Administrator of the National Aeronautics and Space Administration.
 * All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 ******************************************************************************/
package gov.nasa.ensemble.common.runtime;

import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;

/**
 * An IStartupJob should be registered with the
 * gov.nasa.ensemble.common.IStartupJob extension point.
 */
public interface IStartupJob
{
	/**
	 * The return value of this method will be passed to the Job constructor.
	 * 
	 * @return plain word description of this startup job
	 */
	public String getDescription();

	/**
	 * This method will be invoked in the main run loop of a job
	 * 
	 * @param monitor
	 * @return IStatus
	 */
	public IStatus run(IProgressMonitor monitor);
	
}
